Interface ICMPProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
ICMPProcessImpl

public interface ICMPProcess extends Process
Information provided by the PKI file:

    \class IcmpProcess
    
    \brief IcmpProcess is the process that handles and manipulates ICMP.
    
    \example network().getDevice("PC0").getProcess("IcmpProcess")
    
Author:
Auto-generated
  • Method Details

    • startPing

      Short startPing(IPAddress dstIpAddress, int repeatTime, int timeout, int waitTime, String portName)
      Information provided by the PKI file:
      
          \brief Starts a ping to the specified destination and returns the ping process ID.
          
          \param dstIpAddress, the destination IP address.
          \param repeatTime, the repeat time value.
          \param timeout, the timeout value.
          \param waitTime, the wait time value.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return short, the ping process ID.
          
              
      Parameters:
      dstIpAddress - Takes in a parameter of dstIpAddress
      repeatTime - Takes in a parameter of repeatTime
      timeout - Takes in a parameter of timeout
      waitTime - Takes in a parameter of waitTime
      portName - Takes in a parameter of portName
      Returns:
      Short Returns a Short
    • createPingProcess

      Short createPingProcess(IPAddress dstIpAddress, int repeatTime, int timeout, int waitTime, String portName)
      Information provided by the PKI file:
      
          \brief Creates a ping process and returns the ping process ID.
          
          \param dstIpAddress, the destination IP address.
          \param repeatTime, the repeat time value.
          \param timeout, the timeout value.
          \param waitTime, the wait time value.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return short, the ping process ID.
          
              
      Parameters:
      dstIpAddress - Takes in a parameter of dstIpAddress
      repeatTime - Takes in a parameter of repeatTime
      timeout - Takes in a parameter of timeout
      waitTime - Takes in a parameter of waitTime
      portName - Takes in a parameter of portName
      Returns:
      Short Returns a Short
    • getPingProcess

      PingProcess getPingProcess(Short id)
      Information provided by the PKI file:
      
          \brief Returns the PingProcess object associated with specified ping process ID.
          
          \param id, the ID of the ping process of interest.
          
          \return PingProcess, the PingProcess object associated with specified ping process ID.
          
              
      Parameters:
      id - Takes in a parameter of id
      Returns:
      PingProcess Returns a PingProcess
    • startTraceRoute

      Short startTraceRoute(IPAddress dstIpAddress, int probeCount, int minTTL, int maxTTL, int timeout, int waitTime, String portName)
      Information provided by the PKI file:
      
          \brief Starts a traceroute to the specified destination and returns the traceroute process ID.
          
          \param dstIpAddress, the destination IP address.
          \param probeCount, the number of probes to send.
          \param minTTL, the minimum TTL value.
          \param maxTTL, the maximum TTL value.
          \param timeout, the timeout value.
          \param waitTime, the wait time value.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return short, the traceroute process ID.
          
              
      Parameters:
      dstIpAddress - Takes in a parameter of dstIpAddress
      probeCount - Takes in a parameter of probeCount
      minTTL - Takes in a parameter of minTTL
      maxTTL - Takes in a parameter of maxTTL
      timeout - Takes in a parameter of timeout
      waitTime - Takes in a parameter of waitTime
      portName - Takes in a parameter of portName
      Returns:
      Short Returns a Short
    • createTraceRouteProcess

      Short createTraceRouteProcess(IPAddress dstIpAddress, int probeCount, int minTTL, int maxTTL, int timeout, int waitTime, String portName)
      Information provided by the PKI file:
      
          \brief Creates a trace route process and returns the traceroute process ID.
          
          \param dstIpAddress, the destination IP address.
          \param probeCount, the number of probes to send.
          \param minTTL, the minimum TTL value.
          \param maxTTL, the maximum TTL value.
          \param timeout, the timeout value.
          \param waitTime, the wait time value.
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return short, the traceroute process ID.
          
              
      Parameters:
      dstIpAddress - Takes in a parameter of dstIpAddress
      probeCount - Takes in a parameter of probeCount
      minTTL - Takes in a parameter of minTTL
      maxTTL - Takes in a parameter of maxTTL
      timeout - Takes in a parameter of timeout
      waitTime - Takes in a parameter of waitTime
      portName - Takes in a parameter of portName
      Returns:
      Short Returns a Short
    • getTraceRouteProcess

      TraceRouteProcess getTraceRouteProcess(Short id)
      Information provided by the PKI file:
      
          \brief Returns the TraceRouteProcess object associated with specified traceroute process ID.
          
          \param id, the ID of the traceroute process of interest.
          
          \return TraceRouteProcess, the TraceRouteProcess object associated with specified traceroute process ID.
          
              
      Parameters:
      id - Takes in a parameter of id
      Returns:
      TraceRouteProcess Returns a TraceRouteProcess